home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1996 #6 / Amiga Plus CD - 1996 - No. 06.iso / pd / spiele / circle30bpl11 / readme < prev    next >
Text File  |  1992-09-02  |  8KB  |  202 lines
  1.  
  2. CircleMUD 3.00 README file
  3.  
  4. Welcome to CircleMUD 3.0!  I hope you enjoy your stay.
  5.  
  6. Use of this software in any capacity implies that you have read, understood,
  7. and agreed to abide by the terms and conditions set down by the CircleMUD
  8. license contained in the file license.doc.
  9.  
  10. Also, out of courtesy if nothing else, please keep the 'credits' file intact.
  11. You can add your own credits on top of the existing file, but I'd appreciate
  12. it if you would not simply remove it and all references to the word "Circle"
  13. everywhere in the MUD.
  14.  
  15. Jeremy Elson
  16. jelson@jhu.edu
  17.  
  18. ----------------------------------------------------------------------------
  19.  
  20. CircleMUD QuickStart Guide
  21.  
  22. If you are an experienced MUD player and you know your way around a compiler,
  23. you can probably get up and running with this README file alone.  Be aware
  24. that there's a wealth of other information in the doc directory, though, and
  25. if you have problems or questions, that's the first place you should look
  26. for answers.
  27.  
  28. As of Version 3.0, the basic CircleMUD source distribution compiles under
  29. many variants of UNIX (SunOS 4.x, Solaris 2.x, Linux 1.x, IRIX 4.x/5.x,
  30. Ultrix 4.x, HP/UX, and others), Windows 95/NT, and OS/2.
  31.  
  32. The Version 3.0 source does not currently compile under DOS, the Mac, or
  33. the Amiga (although there is a binary distribution of Version 2.20 for the
  34. Amiga).  If you are interested in creating a new port for any of these
  35. platforms, see the file PORTING for some tips.
  36.  
  37. Read the file README.WIN for tips about running Circle 3.0 under Windows
  38. and README.OS2 for tips about using OS/2.
  39.  
  40.  
  41. 1)  Download the latest version of CircleMUD.  You can always find the latest
  42.     version at the following anonymous FTP sites:
  43.  
  44.         ftp.cs.jhu.edu:/pub/CircleMUD
  45.         cambot.res.jhu.edu:/pub/CircleMUD
  46.  
  47.     You can also find information at the WWW site:
  48.  
  49.         http://www.cs.jhu.edu/~jelson/circle.html
  50.  
  51.     The archive is offered in two formats, one which ends in .tar.gz and
  52.     one which ends in .zip.  The files have the same contents but have
  53.     been compressed using different programs.  You should use the .tar.gz
  54.     version if you're using UNIX or the .zip version if you're using
  55.     Windows 95 or OS/2.
  56.  
  57.  
  58. 2)  Unpack the archive.  If you have the .tar.gz version, uncompress it using
  59.     GNU gunzip and the tar archiver by typing this:
  60.  
  61.         gzip -dc circle30xxx.tar.Z | tar xvf -
  62.  
  63.     If you have the .zip version, make sure to use an UNZIP program capable of
  64.     handling long filenames such as the UNIX UnZip program or WinZip for
  65.     Windows 95.  Also, be sure to have your unzip program keep the directory
  66.     structure of the archive instead of uncompressing all the files into the
  67.     same directory.
  68.  
  69.  
  70. The rest of the instructions apply ONLY to UNIX systems.  If you are using
  71. a non-UNIX platform such as Windows or OS/2, stop here and read the README
  72. file specific to your operating system instead (e.g. README.WIN, README.OS2,
  73. etc.)
  74.  
  75.  
  76. 3)  Configure CircleMUD for your system.  Circle must be configured using
  77.     the 'configure' program which attempts to guess correct values for
  78.     various system-dependent variables used during compilation.  It uses
  79.     those values to create a 'Makefile' and a header file called 'conf.h'.
  80.  
  81.     From Circle's root directory, type
  82.  
  83.         ./configure
  84.  
  85.     If you're using 'csh' on an old version of System V, csh might try to
  86.     execute 'configure' itself, giving you a message like "Permission denied"
  87.     when you try to run "./configure".  If so, type "sh ./configure" instead.
  88.  
  89.     'configure' can take several minutes if you're using a slow computer.
  90.  
  91.  
  92. 4)  Build the CircleMUD server.  This must be done from the 'src' directory.
  93.     Type:
  94.    
  95.         cd src; make all
  96.  
  97.     This will build CircleMUD proper as well as its 10 or so ancillary
  98.     utilities, which can take anywhere from 5 minutes to an hour depending
  99.     on the speed of your computer.  Note that in the future, when you need
  100.     to recompile Circle as you make changes to the code, it is NOT necessary
  101.     to run 'configure' again (it should be run only once, after the first
  102.     time you unpack Circle from its .tar file).
  103.  
  104.     The first time you try to compile Circle, you will be asked to read the
  105.     CircleMUD license.  Please read it!
  106.  
  107.  
  108. 5)  Back in Circle's root directory, type 'autorun &' to start the server
  109.     running in the background.  A file called 'syslog' will start growing
  110.     that contains Circle's log messages (and boot messages).
  111.  
  112.  
  113. 6)  Wait until the line 'No connections.  Going to sleep.' appears in the
  114.     syslog.  This indicates that the server is ready and waiting for
  115.     connections.  It shouldn't take more than about 30 seconds for the MUD
  116.     to reach this state, though performance will vary depending on how fast
  117.     your computer is.
  118.  
  119.     If a file appears called 'syslog.CRASH', the MUD has terminated
  120.     (probably abnormally).  Check the contents of syslog.CRASH to see
  121.     what error was encountered.
  122.  
  123.  
  124. 7)  Type 'telnet localhost 4000' to connect.  The first person to log in
  125.     will be made an implementor (level 34) with all powers.
  126.  
  127.  
  128. Other Documentation
  129. -------------------
  130. If the 7-step guide above isn't enough to get you running, there's a lot
  131. more information available.  All documentation (other than this file) is
  132. in the /doc directory.
  133.  
  134. The README file in the /doc directory describes each documentation file
  135. in detail, but there are several main files which should be of interest.
  136. For the administrative side of mudding, running.doc gives an overall
  137. description of how Circle works, how to get it to compile for the first
  138. time and get it running, and hints on maintenance and day-to-day
  139. administration.  For the coding side, coding.doc dives into Circle's
  140. code and describes how to add new commands, spells, skills, socials,
  141. classes, and whatnot.  For the builders in your group, building.doc
  142. describes how to create new worlds, including rooms, objects, mobiles,
  143. and shops.
  144.  
  145.  
  146. Getting Help
  147. ------------
  148. If you have strange problems -- and you can't figure out the answer by
  149. reading the docs -- fear not, there are many other resources you can
  150. turn to.  The best is probably the CircleMUD Mailing List, which you can
  151. subscribe to by writing mail to "majordomo@pvv.unit.no" with a message
  152. body of "subscribe circle".  If you want to write mail to the list, address
  153. it to "circle@pvv.unit.no".  Over 200 CircleMUD imps read that list
  154. regularly, so chances are you'll get help quickly.
  155.  
  156. If that doesn't work, you can always contact me directly by writing to
  157. jelson@jhu.edu.  Or, take a look at the CircleMUD Home Page which is
  158. at http://www.cs.jhu.edu/~jelson/circle.html, which may eventually
  159. have some on-line documentation for Circle.
  160.  
  161. Finally if you have USENET access and are very brave, you can try posting
  162. to the newsgroups rec.games.mud.diku or rec.games.mud.admin.
  163.  
  164. If you write mail asking for help, either to the mailing list or to me,
  165. make sure to include the following information:
  166.  
  167.   -- The exact version of CircleMUD you're using (i.e. "CircleMUD 2.20",
  168.      "CircleMUD 3.0 beta patchlevel 6", etc.).
  169.   -- The EXACT text of any error messages, compiler errors, link errors,
  170.      or any other errors you're getting.
  171.   -- The exact type of hardware, operating system name and version, and
  172.      compiler you're using.
  173.   -- A description of ANY changes you've made, no matter how small, that
  174.      might have contributed to the error.
  175.   -- If you are having trouble getting Circle running for the very first
  176.      time, also be sure to include the output of 'configure' and the file
  177.      'config.log'.
  178.  
  179. Remember, I get dozens of pieces of email every day.  If you don't bother to
  180. give me an excellent description of your problem, I will be somewhat annoyed
  181. and will not be able to help you.  Here is a sample of a piece of mail I got:
  182.  
  183.      hi I need some help with CircleMUD....i tried compiling it on my system
  184.      but I got all sorts of errors, and when i type bin/circle like it says
  185.      in the manual it doesn't work.  Can you help????  you can log into my
  186.      system if you want, the password is mud5.
  187.  
  188. Letters like that are usually ignored.  I get a lot of them!
  189.  
  190.  
  191. Good luck, and have fun!
  192.  
  193. Jeremy Elson
  194. aka Ras/Rasmussen
  195. jelson@jhu.edu
  196.  
  197.  
  198. USE OF THIS SOFTWARE IN ANY CAPACITY IMPLIES THAT YOU HAVE READ, UNDERSTOOD,
  199. AND AGREED TO ABIDE BY THE TERMS AND CONDITIONS SET DOWN BY THE CIRCLEMUD
  200. LICENSE.
  201.  
  202.